Skip to content

Automation (remediation) documentation#39

Merged
zeyu2001 merged 36 commits into
mainfrom
docs/remediation-automations
Jul 22, 2026
Merged

Automation (remediation) documentation#39
zeyu2001 merged 36 commits into
mainfrom
docs/remediation-automations

Conversation

@TheMythologist

@TheMythologist TheMythologist commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Mintlify

1 thread from 1 user in Mintlify

Open in Mintlify Editor

TheMythologist and others added 3 commits July 7, 2026 17:09
New Remediation group under the Platform product:
- platform/remediation/overview: the Remediate button, where the fix PR
  lands (stacked on an open source PR vs default branch), run outcomes,
  and the GitHub App contents:write permission note.
- platform/remediation/automations: creating automations (environments,
  triggers/rules, actions, notifiers), firing semantics, repo-config
  precedence, Slack/email notifications, and run history.
- platform/remediation/credits: per-run deduction, buying credits,
  auto top-up (trigger/target/monthly limit), and the paused state.

Updates:
- code-review/config: document the remediation block (auto, inclusive
  severity defaulting to critical, exclusive override of org automations).
- code-review/findings-feedback: short Remediate section linking over.
- docs.json: add the Remediation navigation group.

Documents the feature landing in HacktronAI/web#475. Changelog entry is
left to the automated changelog workflow once the feature deploys.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ture

Rename the nav group and pages: platform/remediation/* becomes
platform/automations/* with Automations as the overview page and
Remediation as a feature page inside it. Reword intros to match the
hierarchy and update all cross-links.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3348b3b9c9

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread code-review/config.mdx Outdated
TheMythologist and others added 4 commits July 7, 2026 17:58
The absent-config and fail-open descriptions claimed an empty or missing
config.yaml only means normal scans and a green check. With organization
automations, a repository without a remediation block falls through to
enabled org automations, which can start credit-consuming remediation
runs. Say so in both places and point at remediation.auto: false as the
per-repo opt-out.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Updated platform/automations/overview.mdx
- Created images/Screenshot-2026-07-09-at-1.22.05-PM.png
- Created images/automations-1.png
- Created images/Screenshot-2026-07-09-at-1.19.23-PM.png

Mintlify-Source: dashboard-editor
- Updated platform/automations/overview.mdx
- Created images/image.png
- Created images/image-1.png
- Created images/image-2.png

Mintlify-Source: dashboard-editor
- Updated platform/automations/remediation.mdx
- Created images/image.png

Mintlify-Source: dashboard-editor

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8f36460566

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread platform/automations/overview.mdx Outdated
mintlify Bot and others added 3 commits July 10, 2026 06:54
- Updated platform/automations/overview.mdx
- Created images/automations-1-1.png

Mintlify-Source: dashboard-editor
- Updated platform/automations/remediation.mdx
- Created images/image-3.png

Mintlify-Source: dashboard-editor
chatgpt-codex-connector[bot]

This comment was marked as low quality.

mintlify Bot and others added 4 commits July 10, 2026 07:47
- Updated platform/automations/overview.mdx
- Updated platform/automations/remediation.mdx

Mintlify-Source: dashboard-editor
- Updated platform/automations/credits.mdx

Mintlify-Source: dashboard-editor
- Updated platform/automations/overview.mdx

Mintlify-Source: dashboard-editor

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 70cdaf09fb

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread platform/automations/remediation.mdx Outdated
zeyu2001 and others added 6 commits July 10, 2026 17:47
Reframe the Automations overview around triggers, actions, and
notifiers, with Autofix as the first available action and a note that
more actions are coming — the later copyedit passes had rewritten the
intro as autofix-only. Also note the $50 starting credit balance for
Code Review subscribers and add the remediation PR screenshot.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Updated platform/automations/remediation.mdx

Mintlify-Source: dashboard-editor
- Updated platform/account-settings.mdx
- Updated platform/security-settings.mdx
- Updated platform/automations/overview.mdx
- Created images/image.png

Mintlify-Source: dashboard-editor
- Updated platform/automations/overview.mdx

Mintlify-Source: dashboard-editor

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e2a357e608

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread platform/automations/overview.mdx Outdated
Run statuses mirror [remediation outcomes](/platform/automations/remediation#outcomes): **Running**, **Success**, **No fix needed**, **False positive**, and **Failed**. You can filter the history by status and search it.

<img
src="/images/run-history.png"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Add the missing run history image

The light-mode run history screenshot points to /images/run-history.png, but that file is not present in the repo (the commit adds images/image.png for the dark variant, and repo-wide image search shows no run-history.png). Users viewing this section outside dark mode will get a broken image where the run history example should be displayed.

Useful? React with 👍 / 👎.

- Updated platform/automations/overview.mdx

Mintlify-Source: dashboard-editor

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 405c7bf3dc

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread style.css Outdated
@@ -1,3 +1,7 @@
html {
scroll-behavior: smooth;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Respect reduced-motion when enabling smooth scroll

For users who have set prefers-reduced-motion: reduce, this global rule still animates every hash/anchor navigation across the docs site, including pages with many in-page links. That can cause motion discomfort for those users, so please gate smooth scrolling behind @media (prefers-reduced-motion: no-preference) or override it back to auto for reduced-motion environments.

Useful? React with 👍 / 👎.

maekuss and others added 3 commits July 13, 2026 11:29
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Updated platform/automations/credits.mdx
- Created images/A-new-finding-from-Hacktron-after-looking-through-a-PR.-But-it-isn’t-fixed.jpg
- Created images/Screenshot-2026-07-13-at-2.19.57-PM.png

Mintlify-Source: dashboard-editor
- Updated platform/automations/overview.mdx

Mintlify-Source: dashboard-editor
mintlify Bot added 2 commits July 14, 2026 02:45
- Updated platform/automations/credits.mdx
- Created images/Screenshot-2026-07-14-at-10.26.55-AM.png
- Created images/billing.png
- Created images/billing-dashboard.png
- Created images/billing-dashboard-1.png
- Created images/automation.png
- Created images/image-1.png
- Created platform/billing.mdx
- Updated docs.json

Mintlify-Source: dashboard-editor
- Updated platform/billing.mdx
- Updated platform/automations/remediation.mdx
- Updated platform/automations/overview.mdx

Mintlify-Source: dashboard-editor
Comment thread platform/automations/overview.mdx Outdated
Comment on lines +47 to +49
<Info>
A repository with a `remediation` block in its [`.hacktron/config.yaml`](/code-review/config#auto-remediate-findings) follows that block exclusively, including `auto: false`, which turns auto-remediation off for that repository. Organization automations apply only to repositories without a `remediation` block.
</Info>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is no longer accurate - remove. We no longer look at hacktron config for automations - for automations, it's only configurable on our app

Comment thread code-review/config.mdx

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can revert changes in this file - we no longer look at the .hacktron/config.yaml file. Everything is configured through our app frontend now.

Comment thread platform/automations/remediation.mdx Outdated
Comment on lines +71 to +73
<Card title="Repository configuration" icon="file-code" href="/code-review/config#auto-remediate-findings">
Opt a single repository into auto-remediation with a `remediation` block in `.hacktron/config.yaml`.
</Card>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove - we no longer look at the .hacktron/config.yaml file. Everything is configured through our app frontend now.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update screenshots once the new credits/billing page is pushed

Comment thread platform/automations/remediation.mdx Outdated
3. **Tests the fix.** Runs the existing test suite for the repository, if any. Adds relevant regression tests & makes sure the fix correctly addresses the issue while avoiding breaking anything else.
</Card>

Remediation runs use [automation credits](/platform/automations/credits). You can start a run yourself from a finding, let it happen automatically through an [automation](/platform/automations/overview)'s Remediation action or your [repository configuration](/code-review/config#auto-remediate-findings).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No longer possible through repository configuration

Comment thread images/remediation-pr.png

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's update this to show a PR by hacktron-app instead of hacktron-app-stg once it's on prod

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete this file - it's not used

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete this file - it's not used

mintlify Bot and others added 10 commits July 22, 2026 03:47
- Updated platform/billing.mdx
- Updated code-review/billing.mdx

Mintlify-Source: dashboard-editor
- Updated platform/automations/credits.mdx

Mintlify-Source: dashboard-editor
- Updated platform/billing.mdx
- Updated platform/automations/credits.mdx
- Created images/billing.png

Mintlify-Source: dashboard-editor
@zeyu2001
zeyu2001 merged commit 01b6398 into main Jul 22, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants